de.cebis.moccabox.application.request
Interface ITaskRequestHistory

All Known Implementing Classes:

TaskRequestHistoryImpl

public interface ITaskRequestHistory

Interface, das die Historie der ITaskRequest eines Anwenders und die möglichen Zugriffsmethoden darauf kapselt. Es können mehrere ITaskRequest auf den Stack gelegt werden, die anschließend wieder heruntergenommen werden, wenn sich der Anwender entlang seiner Historie wieder zurückbewegt.

Jeder Aufruf (Request) des Anwenders wird in der Historie nach dem LIFO-Prinzip (last-in first-out) abgelegt und muss beim Zurückgehen wieder entfernt werden. Es handelt sich um denselben Aufruf, wenn der Anwender erneut das selbe Kommando zum Ausführen übergibt. In diesem Fall wird der letzte Aufruf desselben Kommandos überschrieben anstatt den neuen Aufruf hinzuzufügen.

Author:

weichelt

Method Summary

void	clean() Bereinigen der Historie und löschen aller ITaskRequest.
void	cleanCurrentTaskRequest() Entfernt den aktuellen ITaskRequest, der als nächstes auf den Stack geschrieben würde.
ITaskRequest	getCurrentTaskRequest() Zurückliefern des aktuellen ITaskRequest.
ITaskRequest	getTaskRequest(int negativOffset) Zurückliefern des ITaskRequest an einer bestimmten Position des Stack der Historie.
java.util.Iterator	iterator() Zurückliefern eines Iterator über alle Einträge der Historie.
ITaskRequest	popTaskRequest() Zurückliefern des obersten ITaskRequest auf dem Stack.
void	pushTaskRequest(ITaskRequest request) Ablegen eines neuen ITaskRequest auf dem Stack der Historie.
void	setCurrentTaskRequest(ITaskRequest request) Setzen des aktuellen ITaskRequest.
int	size() Zurückliefern der Anzahl an ITaskRequest, die auf dem Stack liegen.
void	updateTaskRequest(ITaskRequest request) Ersetzen eines ITaskRequest für ein bestimmtes Kommando durch einen aktualisierten ITaskRequest für dasselbe Kommando.

Method Detail

pushTaskRequest

void pushTaskRequest(ITaskRequest request)

Ablegen eines neuen ITaskRequest auf dem Stack der Historie.

Parameters:

request - Der abzulegende ITaskRequest.

setCurrentTaskRequest

void setCurrentTaskRequest(ITaskRequest request)

Setzen des aktuellen ITaskRequest. Dieser ist noch nicht auf dem Stack, sondern lediglich der nächste Request, der auf den Stack gelegt wird, sobald ein neuer aktueller Request gesetzt wird, der ein anderes Kommando enthält als das des CurrentRequest. Ist das Kommando dasselbe, so wird der aktuelle ITaskRequest lediglich aktualisiert, aber nicht in die Historie geschrieben.

Parameters:

request - Der aktuelle ITaskRequest.

cleanCurrentTaskRequest

void cleanCurrentTaskRequest()

Entfernt den aktuellen ITaskRequest, der als nächstes auf den Stack geschrieben würde.

getCurrentTaskRequest

ITaskRequest getCurrentTaskRequest()

Zurückliefern des aktuellen ITaskRequest. Dieser ist noch nicht Teil der Historie sondern der Request, der aktuell vom Anwender ausgeführt wird.

Returns:

Der aktuelle ITaskRequest.

getTaskRequest

ITaskRequest getTaskRequest(int negativOffset)

Zurückliefern des ITaskRequest an einer bestimmten Position des Stack der Historie.

Parameters:

negativOffset - Bestimmt, der wievielte ITaskRequest von oben vom Stack zurückgeliefert werden soll (oberster = 0; darunter = -1; usw.). Alle darüber liegenden ITaskRequest werden vom Stack entfernt.

Returns:

Der

size

int size()

Zurückliefern der Anzahl an ITaskRequest, die auf dem Stack liegen. Bestimmt die Anzahl der Schritte, die in der Historie zurückgegangen werden können.

Returns:

Größe des Stack.

popTaskRequest

ITaskRequest popTaskRequest()

Zurückliefern des obersten ITaskRequest auf dem Stack.

Returns:

Der ITaskRequest, der zuletzt auf den Stack gelegt wurde.

updateTaskRequest

void updateTaskRequest(ITaskRequest request)

Ersetzen eines ITaskRequest für ein bestimmtes Kommando durch einen aktualisierten ITaskRequest für dasselbe Kommando.

Parameters:

request - Der ITaskRequest, der einen vorhandenen mit demselben Kommando aktualisieren soll.

clean

void clean()

Bereinigen der Historie und löschen aller ITaskRequest.

iterator

java.util.Iterator iterator()

Zurückliefern eines Iterator über alle Einträge der Historie.

Returns:

Iterator über die Einträge der Historie.